home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d21 / apitools.arc / C.DOC < prev    next >
Text File  |  1989-02-24  |  12KB  |  275 lines
  1.                      C Interfaces
  2.  
  3. Listed below are the DESQview API C interfaces available with the
  4. DESQview API C Library.
  5.  
  6.  
  7. General Functions
  8.  
  9. api_beginc      begin critical region
  10. api_cancel      cancel current Window Mgr operation
  11. api_endc        end critical region
  12. api_exit        exit API interface
  13. api_freebit     disconnect 2nd level interrupt handler
  14. api_getbit      define 2nd level interrupt handler
  15. api_getcrit     get critical region nesting level
  16. api_getmem      get system memory buffer
  17. api_init        initialize API interface
  18. api_isobj       determine if a given handle is valid
  19. api_justify     enable/disable automatic justification of window
  20. api_kmouse      turn keyboard mouse on and off
  21. api_level       define API revision level required by application
  22. api_objtype     determine the object type of a given handle
  23. api_pause       give other tasks a chance to run
  24. api_poke        display debug information/bottomline of screen
  25. api_putmem      return system memory buffer
  26. api_pushkey     push key into input stream
  27. api_setbit      schedule 2nd level interrupt handler
  28. api_shadow      get task's logical window buffer& start shadowing
  29. api_sound       make a sound
  30. api_update      redraw portion of logical window and stop shadowing
  31.  
  32.  
  33. Application Management Functions
  34.  
  35. app_foreonly    indicate whether a task can run in background
  36. app_free        free an application and its window
  37. app_goback      force an application into background
  38. app_gofore      force an application into foreground
  39. app_hide        hide all windows of an application
  40. app_new         create a new application in the current process
  41. app_number      get current applications SWITCH number
  42. app_show        display all windows of an application
  43. app_start       start a new application in a new process
  44. app_suspend     suspend & hide all application's tasks
  45.  
  46.  
  47. Field Management Functions
  48.  
  49. fld_altmode     set Alternate field processing mode
  50. fld_attr        fill a field with a given attribute
  51. fld_char        fill a field with a given character
  52. fld_clear       clear a field
  53. fld_cursor      move cursor to a field
  54. fld_entry       change field table entry
  55. fld_header      change field table header
  56. fld_marker      define selected field marker character
  57. fld_point       move pointer to given position in field
  58. fld_protattr    set Protected Attributes field processing mode
  59. fld_reset       reset selected and modified bits
  60. fld_scroll      scroll a field
  61. fld_swrite      write a string into a field
  62. fld_type        change the type of a field
  63. fld_write       write characters into a field
  64.  
  65.  
  66. Keyboard Management Functions
  67.  
  68. key_addto       set keyboard behavior flags
  69. key_close       disconnect keyboard from its window
  70. key_erase       discard pending keyboard input
  71. key_free        free a keyboard object
  72. key_getc        wait for next key (keystroke mode)
  73. key_getflags    get keyboard control flags
  74. key_getpri      get objectq priority level of keyboard
  75. key_me          get current tasks keyboard handle
  76. key_new         create a new keyboard object
  77. key_of          get handle of a given task's keyboard
  78. key_open        attach keyboard to a given window
  79. key_read        read input from keyboard
  80. key_setesc      define function to filter keys in field mode
  81. key_setflags    replace keyboard control flags
  82. key_setpri      set objectq priority level of keyboard
  83. key_sizeof      get # keyboard messages pending
  84. key_status      get status of last keyboard message
  85. key_subfrom     clear keyboard behavior flags
  86. key_write       write data to keyboard
  87.  
  88.  
  89. Mailbox Management Functions
  90.  
  91. mal_addr        return sender of last message
  92. mal_addto       send message by value with given status
  93. mal_close       close a mailbox
  94. mal_erase       erase all pending messages
  95. mal_find        find a mailbox by name
  96. mal_free        free a mailbox object
  97. mal_getflags    get mailbox control flags
  98. mal_getpri      get objectq priority level of mailbox
  99. mal_lock        lock access to a resource
  100. mal_me          get handle of MAILME mailbox
  101. mal_name        assign a global name to a mailbox
  102. mal_new         create a new mailbox
  103. mal_of          get handle of a given task's mailbox
  104. mal_open        open a mailbox
  105. mal_read        wait for next message
  106. mal_setflags    replace mailbox control flags
  107. mal_setpri      set objectq priority level of mailbox
  108. mal_sizeof      get # messages pending
  109. mal_status      get status of last message received
  110. mal_subfrom     send message by reference with given status
  111. mal_unlock      unlock access to a resource
  112. mal_write       send a message by value with status zero
  113.  
  114.  
  115. Objectq Management Functions
  116.  
  117. obq_close       close the task's objectq
  118. obq_erase       erase contents of the task's objectq
  119. obq_open        open the task's objectq
  120. obj_read        wait for any object to have input
  121. obq_sizeof      get # of objectq entries pending
  122. obq_status      determine if the task's objectq is open
  123. obq_subfrom     remove an object from the task's obectq
  124.  
  125.  
  126. Panel Management Functions
  127.  
  128. pan_apply       display a named panel & prepare for input
  129. pan_close       close a panel file
  130. pan_dir         get list of panels in the panel file
  131. pan_free        free a panel object
  132. pan_new         create a panel object
  133. pan_open        open a panel file
  134. pan_sizeof      get # panels in the panel file
  135. pan_status      get status of last pan_open or pan_apply
  136.  
  137.  
  138. Pointer Management Functions
  139.  
  140. ptr_addto       set pointer control flags
  141. ptr_close       close a pointer object
  142. ptr_erase       erase pending pointer messages
  143. ptr_free        free a pointer object
  144. ptr_getflags    get pointer control flags
  145. ptr_getpri      get objectq priority level of pointer
  146. ptr_getscale    get current scaling factors
  147. ptr_new         create a new pointer object
  148. ptr_open        open pointer and assign to a window
  149. ptr_read        wait for next pointer message
  150. ptr_setflags    replace pointer control flags
  151. ptr_setpri      set objectq priority level of pointer
  152. ptr_setscale    set current scaling factors
  153. ptr_sizeof      get # messages pending
  154. ptr_status      get button state from last message received
  155. ptr_subfrom     clear pointer control flags
  156. ptr_write       move the pointer to a given position
  157.  
  158.  
  159. Query Functions
  160.  
  161. qry_atread      TRUE if win_read and win_readn reads attributes
  162. qry_attr        get current output attribute
  163. qry_color       get physical attribute for given logical attribute
  164. qry_ctrl        TRUE if processing control codes
  165. qry_cursor      get current cursor position
  166. qry_entry       get field table entry
  167. qry_field       get contents of a field
  168. qry_frame       TRUE if the window has a frame
  169. qry_frattr      get current frame attribute
  170. qry_header      get field table header
  171. qry_hidden      TRUE if the window is hidden
  172. qry_kmouse      TRUE if using a keyboard mouse
  173. qry_leave       TRUE if leaving attribute untouched when writing
  174. qry_lsize       get size of logical window buffer
  175. qry_logattr     TRUE if using logical attributes
  176. qry_origin      get origin of physical window relative to logical
  177. qry_position    get position of physical window
  178. qry_size        get size of physical window
  179. qry_title       get window's title
  180. qry_type        get type of field
  181.  
  182.  
  183. Timer Management Functions
  184.  
  185. tim_addto       start a timer for a given interval
  186. tim_close       close a timer object
  187. tim_erase       stop a running timer
  188. tim_free        free a timer object
  189. tim_getpri      get objectq priority level of timer
  190. tim_len         get time remaining until timer expires
  191. tim_new         create a new timer object
  192. tim_open        open a timer object
  193. tim_read        wait for timer to expire
  194. tim_setpri      set objectq priority level of timer
  195. tim_sizeof      get time since a timer started running
  196. tim_status      determine if a timer is running
  197. tim_write       start a timer for a given time of day
  198.  
  199.  
  200. Task Management Functions
  201.  
  202. tsk_free        free a task and its window
  203. tsk_geterror    get error handling level of current task
  204. tsk_me          get handle of current task
  205. tsk_new         create a new task
  206. tsk_pgmint      software interrupt another task
  207. tsk_post        restart a task and post its Objectq
  208. tsk_seterror    set error handling level of current task
  209. tsk_start       restart a stopped task
  210. tsk_stop        temporarily stop a task
  211.  
  212.  
  213. Window Management Functions
  214.  
  215. win_addto       write characters and attributes to a window
  216. win_adopt       adopt a window
  217. win_allow       specify which DESQview commands are allowed for a window
  218. win_async       define asynchronous notify function
  219. win_atread      sets read mode to read either charaters or attributes
  220. win_attach      attach window to its parent task window
  221. win_attr        set current output attribute
  222. win_blanks      write blanks to a window
  223. win_bottom      make window bottommost in its application
  224. win_buffer      get pointer to window's logical window     buffer
  225. win_cancel      cancel notification on a given event
  226. win_color       change logical attribute mapping
  227. win_ctrl        enable/disable interpretation of control characters
  228. win_cursor      move window's logical cursor
  229. win_dflt        change default notify window
  230. win_disallow    specify which DESQview commands are not allowed for a window
  231. win_disperor    display an error message window
  232. win_eof         TRUE if logical cursor is beyond end of window
  233. win_erase       clear window
  234. win_frame       enable/disable display of a window's frame
  235. win_frattr      define window frame attribute
  236. win_free        remove a window from the screen and free its handle
  237. win_hcur        display hardware cursor at logical cursor position
  238. win_hide        marks a window as hidden
  239. win_leave       leave existing attribute when writing to a window
  240. win_len         return width of logical window
  241. win_locate      return which window is visible at the given screen row/col
  242. win_logattr     use logical/physical attributes
  243. win_lsize       set windows logical dimensions
  244. win_maxsize     set windows maximum physical dimensions
  245. win_me          get current task's window handle
  246. win_minsize     set windows minimum physical dimensions
  247. win_move        move physical window
  248. win_new         create a new window
  249. win_notify      enable notification on a given event
  250. win_nread       read n characters from a window
  251. win_open        fill a window with a given character
  252. win_origin      define portion of logical window viewed in the physical window
  253. win_orphan      orphan a window
  254. win_paste       define window as current clipboard window
  255. win_point       jump mouse to logical cursor position
  256. win_poswin      position window relative to another window
  257. win_printf      write formatted data to a window
  258. win_putc        write a character/attribute pair to a window
  259. win_read        read rest of current line from window
  260. win_redraw      redraw a window
  261. win_reorder     reorder an application's windows
  262. win_repattr     write an attribute to a window n times
  263. win_repchar     write a character to a window n times
  264. win_resize      set physical dimensions of window
  265. win_scroll      scroll all or part of a window
  266. win_sizeof      get total number of characters in logical window
  267. win_stream      write a stream to a window
  268. win_subfrom     write attributes to a window
  269. win_swrite      write a zero terminated string to a window
  270. win_title       change a windows title
  271. win_top         make window topmost in application
  272. win_topsys      make window topmost in system
  273. win_unhide      marks a window as not hidden
  274. win_write       write characters to a window
  275.